| Package | hl7.fhir.us.davinci-cdex |
| Type | CapabilityStatement |
| Id | Id |
| FHIR Version | R4 |
| Source | http://hl7.org/fhir/us/davinci-cdex/https://build.fhir.org/ig/HL7/davinci-ecdx/CapabilityStatement-data-source-client.html |
| Url | http://hl7.org/fhir/us/davinci-cdex/CapabilityStatement/data-source-client |
| Version | 2.1.0-snapshot |
| Status | active |
| Date | 2024-09-10T14:37:40.292045-08:00 |
| Name | DataSourceClientCapabilityStatement |
| Title | Data Source Client CapabilityStatement |
| Experimental | False |
| Realm | us |
| Authority | hl7 |
| Description | This CapabilityStatement describes the expected capabilities of a Da Vinci CDex Data Source in *Client* mode during clinical data exchange with a Data Consumer. The capabilities include one or more of the following interactions: 1. Post the `$submit-attachment` operation to a Data Consumer endpoint. 2. Launch Da Vinci DTR. 3. Query for Authorization information represented by a CommunicationRequest or ServiceRequest. 4. Post a subscription notification to a Data Consumer endpoint updating the status of a task. |
| Copyright | Used by permission of HL7 International all rights reserved Creative Commons License |
| Kind | requirements |
No resources found
| CapabilityStatement | |
http://hl7.org/fhir/us/core/CapabilityStatement/us-core-client  | US Core Client CapabilityStatement |
| http://hl7.org/fhir/us/davinci-dtr/ImplementationGuide/hl7.fhir.us.davinci-dtr | Da Vinci - Documentation Templates and Rules |
| http://hl7.org/fhir/us/davinci-cdex/OperationDefinition/submit-attachment | Submit Attachment Operation |
| http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-sdc-questionnaireresponse | CDex SDC QuestionnaireResponse Profile |
| http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference | US Core DocumentReference Profile |
Note: links and images are rebased to the (stated) source
Used by permission of HL7 International all rights reserved Creative Commons License
This CapabilityStatement describes the expected capabilities of a Da Vinci CDex Data Source in Client mode during clinical data exchange with a Data Consumer. The capabilities include one or more of the following interactions:
FHIR$submit-attachment operation to a Data Consumer endpoint.Jump to:
The Da Vinci CDex Data Source Client SHALL:
Support at least one of the CDex approaches for exchanging clinical information
Follow the guidelines for Generating and Verifying Signed Resources if signatures are required.
Support JSON source formats for all Da Vinci CDex interactions.
Declare a CapabilityStatement identifying transactions, and profiles supported.
Support XML source formats for all Da Vinci CDex interactions.
Implementers that choose to support XML need to be aware that JSON Web Signatures can only be created and validated in the original native JSON. Transforms to and from XML will invalidate signatures.
Security:
transaction interaction.batch interaction.search-system interaction.history-system interaction.submit-attachment+ operation.+submit-attachmentIf Attachments is supported, the Data Source Client SHALL support the
$submit-attachmentoperation.
| Resource Type | Supported Interactions | Supported Profiles | Supported Searches | Supported _includes |
Supported _revincludes |
Supported Operations |
|---|---|---|---|---|---|---|
| CommunicationRequest | create, search-type, read, vread, update, patch, delete, history-instance, history-type, | |||||
| DocumentReference | create, search-type, read, vread, update, patch, delete, history-instance, history-type, | US Core DocumentReference Profileversion: {0}3.1.1), US Core DocumentReference Profileversion: {0}6.1.0), US Core DocumentReference Profileversion: {0}7.0.0), | ||||
| Parameters | create, search-type, read, vread, update, patch, delete, history-instance, history-type, | |||||
| QuestionnaireResponse | create, search-type, read, vread, update, patch, delete, history-instance, history-type, | CDex SDC QuestionnaireResponse Profileversion: {0}2.1.0-snapshot), | ||||
| ServiceRequest | create, search-type, read, vread, update, patch, delete, history-instance, history-type, |
Conformance Expectation: SHOULD
Resource Specific Documentation:
Required resource type to carry authorization information regarding for requesting Clinical information
Modify Criteria:
create interaction posting a CommunicationRequest resource using:
POST [base]/CommunicationRequest/[id]{?_format=[mime-type]}
PUT [base]/CommunicationRequest/[id]{?_format=[mime-type]}
PATCH [base]/CommunicationRequest/[id]{?_format=[mime-type]}
DELETE [base]//[id]
Fetch and Search Criteria:
search-type interaction fetching CommunicationRequest resources matching a search query using:
GET [base]/CommunicationRequest/[id]{?[parameters]{&_format=[mime-type]}}
read interaction fetching a CommunicationRequest resource using:
GET [base]/CommunicationRequest/[id]
vread interaction fetching a CommunicationRequest resource using:
GET [base]/CommunicationRequest/[id]/_history/vid
history-instance interaction fetching a history of a CommunicationRequest using:
GET [base]/CommunicationRequest/[id]/_history{?[parameters]&_format=[mime-type]}
history-type interaction fetching the history of CommunicationRequest resources using:
GET [base]/CommunicationRequest/_history{?[parameters]&_format=[mime-type]}
Conformance Expectation: SHOULD
Resource Specific Documentation:
Required resource type to support the
$submit-attachmentoperation
Supported Profiles:
Modify Criteria:
create interaction posting a DocumentReference resource using:
POST [base]/DocumentReference/[id]{?_format=[mime-type]}
PUT [base]/DocumentReference/[id]{?_format=[mime-type]}
PATCH [base]/DocumentReference/[id]{?_format=[mime-type]}
DELETE [base]//[id]
Fetch and Search Criteria:
search-type interaction fetching DocumentReference resources matching a search query using:
GET [base]/DocumentReference/[id]{?[parameters]{&_format=[mime-type]}}
read interaction fetching a DocumentReference resource using:
GET [base]/DocumentReference/[id]
vread interaction fetching a DocumentReference resource using:
GET [base]/DocumentReference/[id]/_history/vid
history-instance interaction fetching a history of a DocumentReference using:
GET [base]/DocumentReference/[id]/_history{?[parameters]&_format=[mime-type]}
history-type interaction fetching the history of DocumentReference resources using:
GET [base]/DocumentReference/_history{?[parameters]&_format=[mime-type]}
Conformance Expectation: SHOULD
Resource Specific Documentation:
Required resource type to support the
$submit-attachmentoperation
Modify Criteria:
create interaction posting a Parameters resource using:
POST [base]/Parameters/[id]{?_format=[mime-type]}
PUT [base]/Parameters/[id]{?_format=[mime-type]}
PATCH [base]/Parameters/[id]{?_format=[mime-type]}
DELETE [base]//[id]
Fetch and Search Criteria:
search-type interaction fetching Parameters resources matching a search query using:
GET [base]/Parameters/[id]{?[parameters]{&_format=[mime-type]}}
read interaction fetching a Parameters resource using:
GET [base]/Parameters/[id]
vread interaction fetching a Parameters resource using:
GET [base]/Parameters/[id]/_history/vid
history-instance interaction fetching a history of a Parameters using:
GET [base]/Parameters/[id]/_history{?[parameters]&_format=[mime-type]}
history-type interaction fetching the history of Parameters resources using:
GET [base]/Parameters/_history{?[parameters]&_format=[mime-type]}
Conformance Expectation: SHOULD
Resource Specific Documentation:
Required resource type to support the
$submit-attachmentoperation for Requesting Attachments Using Questionnaires. SHALL* support CDex SDC QuestionnaireResponse Profile for signed QuestionnaireResponse.
Supported Profiles:
Modify Criteria:
create interaction posting a QuestionnaireResponse resource using:
POST [base]/QuestionnaireResponse/[id]{?_format=[mime-type]}
PUT [base]/QuestionnaireResponse/[id]{?_format=[mime-type]}
PATCH [base]/QuestionnaireResponse/[id]{?_format=[mime-type]}
DELETE [base]//[id]
Fetch and Search Criteria:
search-type interaction fetching QuestionnaireResponse resources matching a search query using:
GET [base]/QuestionnaireResponse/[id]{?[parameters]{&_format=[mime-type]}}
read interaction fetching a QuestionnaireResponse resource using:
GET [base]/QuestionnaireResponse/[id]
vread interaction fetching a QuestionnaireResponse resource using:
GET [base]/QuestionnaireResponse/[id]/_history/vid
history-instance interaction fetching a history of a QuestionnaireResponse using:
GET [base]/QuestionnaireResponse/[id]/_history{?[parameters]&_format=[mime-type]}
history-type interaction fetching the history of QuestionnaireResponse resources using:
GET [base]/QuestionnaireResponse/_history{?[parameters]&_format=[mime-type]}
Conformance Expectation: SHOULD
Resource Specific Documentation:
Required resource type to carry authorization information regarding for requesting Clinical information
Modify Criteria:
create interaction posting a ServiceRequest resource using:
POST [base]/ServiceRequest/[id]{?_format=[mime-type]}
PUT [base]/ServiceRequest/[id]{?_format=[mime-type]}
PATCH [base]/ServiceRequest/[id]{?_format=[mime-type]}
DELETE [base]//[id]
Fetch and Search Criteria:
search-type interaction fetching ServiceRequest resources matching a search query using:
GET [base]/ServiceRequest/[id]{?[parameters]{&_format=[mime-type]}}
read interaction fetching a ServiceRequest resource using:
GET [base]/ServiceRequest/[id]
vread interaction fetching a ServiceRequest resource using:
GET [base]/ServiceRequest/[id]/_history/vid
history-instance interaction fetching a history of a ServiceRequest using:
GET [base]/ServiceRequest/[id]/_history{?[parameters]&_format=[mime-type]}
history-type interaction fetching the history of ServiceRequest resources using:
GET [base]/ServiceRequest/_history{?[parameters]&_format=[mime-type]}
{
"resourceType" : "CapabilityStatement",
"id" : "data-source-client",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <!-- TODO \n Jurisdiction \n Prohibited extension - http://hl7.org/fhir/StructureDefinition/capabilitystatement-prohibited -->\n <!-- set include_symbols = false to turn off confonrmance symbols and legen, true to turn on -->\n \n \n <h2 id=\"title\">Data Source Client CapabilityStatement</h2>\n <ul>\n <li><b>Title:</b>Data Source Client CapabilityStatement</li>\n <li><b>Implementation Guide Version:</b> 2.1.0-snapshot</li>\n <li><b>FHIR Version:</b> 4.0.1</li>\n <li><b>Intended Use:</b> Requirements</li>\n <li><b>Supported Formats: </b> \n\n \n \n \n <strong>SHALL</strong> support \n \n json;\n \n \n \n <strong>MAY</strong> support \n \n xml;\n \n\n </li>\n \n <li><b>Published:</b> 2024-09-10 14:37:40-0800</li>\n \n <li><b>Published by:</b> HL7 International / Payer/Provider Information Exchange Work Group</li>\n <li><b>Status:</b> Active</li>\n <li><b>Copyright:</b> <div><p>Used by permission of HL7 International all rights reserved Creative Commons License</p>\n</div></li>\n </ul>\n <br/>\n\n\n\n \n <strong>Description:</strong> <div><div><p>This CapabilityStatement describes the expected capabilities of a Da Vinci CDex Data Source in <em>Client</em> mode during clinical data exchange with a Data Consumer. The capabilities include one or more of the following interactions:</p>\n<ol>\n<li>Post the <code>$submit-attachment</code> operation to a Data Consumer endpoint.</li>\n<li>Launch Da Vinci DTR.</li>\n<li>Query for Authorization information represented by a CommunicationRequest or ServiceRequest.</li>\n<li>Post a subscription notification to a Data Consumer endpoint updating the status of a task.</li>\n</ol>\n</div></div>\n \n <br/>\n \n \n\n\n \n <h3>Support and Requirements for Other Artifacts</h3>\n \n <tr>\n <th>Instantiates other capabilities:</th>\n <td>\n <ul>\n \n <li>\n \n <strong>SHOULD</strong> support \n \n <a href=\"http://hl7.org/fhir/us/core/STU3.1.1/CapabilityStatement-us-core-client.html\">US Core Client CapabilityStatementversion: {0}3.1.1)</a>\n </li>\n \n <li>\n \n <strong>SHOULD</strong> support \n \n <a href=\"http://hl7.org/fhir/us/core/STU6.1/CapabilityStatement-us-core-client.html\">US Core Client CapabilityStatementversion: {0}6.1.0)</a>\n </li>\n \n <li>\n \n <strong>SHOULD</strong> support \n \n <a href=\"http://hl7.org/fhir/us/core/STU7/CapabilityStatement-us-core-client.html\">US Core Client CapabilityStatementversion: {0}7.0.0)</a>\n </li>\n \n </ul>\n </td>\n </tr>\n \n \n \n <tr>\n <th>Supports other guides:</th>\n <td>\n <ul>\n \n <li>\n \n <strong>SHOULD</strong> support \n \n <a href=\"http://hl7.org/fhir/us/davinci-dtr/STU2/ImplementationGuide-hl7.fhir.us.davinci-dtr.html\">Da Vinci - Documentation Templates and Rulesversion: {0}2.0.1)</a>\n </li>\n \n </ul>\n </td>\n </tr>\n \n \n\n <br/>\n <!-- TODO - Make this a summary of capabilities, including system wide and each paradigm -->\n <p>\n <b>Jump to:</b>\n </p>\n <ul>\n \n <li><a href=\"#Client\">REST Client</a></li>\n \n \n \n </ul>\n\n\n\n <!-- REST Capabilities -->\n \n <br/>\n <a name=\"Client\"> </a>\n <h3 id=\"behavior\">FHIR Client RESTful Capabilities</h3>\n \n <div><div><p>The Da Vinci CDex Data Source Client <strong>SHALL</strong>:</p>\n<ol>\n<li>\n<p>Support at least one of the CDex approaches for exchanging clinical information</p>\n<ol>\n<li>Task-Based Approach</li>\n<li>Attachments</li>\n</ol>\n</li>\n<li>\n<p>Follow the guidelines for <a href=\"signatures.html\">Generating and Verifying Signed Resources</a> <em>if signatures are required</em>.</p>\n</li>\n<li>\n<p>Support JSON source formats for all Da Vinci CDex interactions.</p>\n</li>\n<li>\n<p>Declare a CapabilityStatement identifying transactions, and profiles supported.</p>\n<ul>\n<li>Follow the guidelines for <a href=\"attachments-conformance.html\">Conforming to CDex Attachments</a> if supporting this exchange.\nThe Da Vinci CDex Data Source Client <strong>MAY</strong>:</li>\n</ul>\n</li>\n<li>\n<p>Support XML source formats for all Da Vinci CDex interactions.</p>\n<blockquote>\n<p>Implementers that choose to support XML need to be aware that JSON Web Signatures can only be created and validated in the original native JSON. Transforms to and from XML will invalidate signatures.</p>\n</blockquote>\n</li>\n</ol>\n</div></div>\n \n\n <!-- REST Security -->\n \n <br/>\n <p id=\"security\"><strong>Security:</strong></p>\n \n <div><div><ol>\n<li>For general security consideration refer to the FHIR <a href=\"http://build.fhir.org/secpriv-module.html\">Security and Privacy Considerations</a>.</li>\n<li>For security considerations specific to this guide refer to the <a href=\"security.html\">Security and Privacy</a> section.</li>\n</ol>\n</div></div>\n \n \n \n\n <!-- REST System wide Capabilities -->\n \n <h3>System-wide Client Capabilities</h3>\n \n <!-- REST System wide interactions -->\n \n <h4>Interactions</h4>\n\n <ul>\n \n <li>\n \n <strong>MAY</strong> support the \n \n <code>transaction</code> interaction.</li>\n \n <li>\n \n <strong>MAY</strong> support the \n \n <code>batch</code> interaction.</li>\n \n <li>\n \n <strong>MAY</strong> support the \n \n <code>search-system</code> interaction.</li>\n \n <li>\n \n <strong>MAY</strong> support the \n \n <code>history-system</code> interaction.</li>\n \n </ul>\n \n \n \n \n \n \n \n \n \n \n\n <!-- REST System wide operations -->\n \n <h4>Operations</h4>\n\n <ul>\n \n <li>\n \n <strong>SHOULD</strong> support the \n \n <code>submit-attachment</code><sup>+</sup> operation.</li>\n \n </ul>\n \n \n <blockquote>\n <sup>+</sup>submit-attachment<div><p>If <a href=\"attachments.html\">Attachments</a> is supported, the Data Source Client <strong>SHALL</strong> support the <code>$submit-attachment</code> operation.</p>\n</div>\n </blockquote>\n \n \n \n\n\n <!-- REST System wide search parameters -->\n \n \n\n\n\n <!-- Resource Capabilities -->\n \n\n <h4>Summary of Resource/Profile Capabilities</h4>\n <!-- TODO need include conformance verb legend -->\n \n <table class=\"grid\">\n <thead>\n <tr>\n <th>Resource Type</th>\n <th>Supported Interactions</th>\n <th>Supported Profiles</th>\n <th>Supported Searches</th>\n <th>Supported <code>_includes</code></th>\n <th>Supported <code>_revincludes</code></th>\n <th>Supported Operations</th>\n </tr>\n </thead>\n <tbody>\n \n <tr>\n <td>\n <a href=\"#Client_CommunicationRequest\"><span style=\"white-space: nowrap;\">CommunicationRequest</span></a>\n </td>\n\n <!-- Supported Interactions -->\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td>\n\n <!-- Supported Profiles -->\n <td>\n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>\n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#Client_DocumentReference\"><span style=\"white-space: nowrap;\">DocumentReference</span></a>\n </td>\n\n <!-- Supported Interactions -->\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td>\n\n <!-- Supported Profiles -->\n <td>\n \n <a href=\"http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-documentreference.html\">US Core DocumentReference Profileversion: {0}3.1.1)</a>,\n \n \n <a href=\"http://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-documentreference.html\">US Core DocumentReference Profileversion: {0}6.1.0)</a>,\n \n \n <a href=\"http://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-documentreference.html\">US Core DocumentReference Profileversion: {0}7.0.0)</a>,\n \n \n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>\n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#Client_Parameters\"><span style=\"white-space: nowrap;\">Parameters</span></a>\n </td>\n\n <!-- Supported Interactions -->\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td>\n\n <!-- Supported Profiles -->\n <td>\n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>\n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#Client_QuestionnaireResponse\"><span style=\"white-space: nowrap;\">QuestionnaireResponse</span></a>\n </td>\n\n <!-- Supported Interactions -->\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td>\n\n <!-- Supported Profiles -->\n <td>\n \n <a href=\"StructureDefinition-cdex-sdc-questionnaireresponse.html\">CDex SDC QuestionnaireResponse Profileversion: {0}2.1.0-snapshot)</a>,\n \n \n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>\n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <a href=\"#Client_ServiceRequest\"><span style=\"white-space: nowrap;\">ServiceRequest</span></a>\n </td>\n\n <!-- Supported Interactions -->\n <td>\n \n \n <span style=\"white-space: nowrap;\">create</span>,\n \n <span style=\"white-space: nowrap;\">search-type</span>,\n \n <span style=\"white-space: nowrap;\">read</span>,\n \n <span style=\"white-space: nowrap;\">vread</span>,\n \n <span style=\"white-space: nowrap;\">update</span>,\n \n <span style=\"white-space: nowrap;\">patch</span>,\n \n <span style=\"white-space: nowrap;\">delete</span>,\n \n <span style=\"white-space: nowrap;\">history-instance</span>,\n \n <span style=\"white-space: nowrap;\">history-type</span>,\n \n \n </td>\n\n <!-- Supported Profiles -->\n <td>\n \n </td>\n\n <!-- Supported Searches will need to do some sort of mapping instead of join to get the expectations printed out -->\n <td>\n \n </td>\n\n <!-- Supported _includes -->\n <td>\n \n </td>\n\n <!-- Supported _revincludes -->\n <td>\n \n </td>\n\n <!-- Supported Operations -->\n <td>\n \n </td>\n </tr>\n \n </tbody>\n </table>\n <br/>\n\n <h3 id=\"resource-details\" class=\"no_toc\">RESTful Client Capabilities by Resource/Profile:</h3>\n <!-- Each REST Resource Detail -->\n \n <h4 id=\"Client_CommunicationRequest\" class=\"no_toc\">CommunicationRequest</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n\n <p>Resource Specific Documentation:</p>\n <blockquote><div><p>Required resource type to carry authorization information regarding for requesting Clinical information</p>\n</div></blockquote>\n\n \n\n \n \n\n\n <p>\n \n\n \n\n \n\n \n </p>\n\n\n\n\n\n\n <!-- Resource Interactions -->\n \n\n <!-- Resource Operations -->\n \n\n\n\n <!-- TODO Nexted ul items do not appear with a subbullet style -->\n \n <br/>\n <p>Modify Criteria:</p> \n <ul>\n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>create</code> interaction posting a CommunicationRequest resource using:\n <code class=\"highlighter-rouge\">POST [base]/CommunicationRequest/[id]{?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A Client <strong>MAY</strong> be capable of putting a existing CommunicationRequest resource using:\n <code class=\"highlighter-rouge\">PUT [base]/CommunicationRequest/[id]{?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n <li>\n A Client <strong>MAY</strong> be capable of patching an existing CommunicationRequest resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/CommunicationRequest/[id]{?_format=[mime-type]}</code>\n </li>\n \n\n \n \n\n \n\n \n <li>\n A Client <strong>MAY</strong> be capable of deleting a CommunicationRequest resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n </ul>\n \n\n\n \n <br/>\n <p>Fetch and Search Criteria:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>search-type</code> interaction fetching CommunicationRequest resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/CommunicationRequest/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>read</code> interaction fetching a CommunicationRequest resource using:\n <code class=\"highlighter-rouge\">GET [base]/CommunicationRequest/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a CommunicationRequest resource using:\n <code class=\"highlighter-rouge\">GET [base]/CommunicationRequest/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-instance</code> interaction fetching a history of a CommunicationRequest using:\n <code class=\"highlighter-rouge\">GET [base]/CommunicationRequest/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of CommunicationRequest resources using:\n <code class=\"highlighter-rouge\">GET [base]/CommunicationRequest/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n\n </ul>\n \n\n \n\n <!-- Search Combination -->\n \n \n \n\n \n <h4 id=\"Client_DocumentReference\" class=\"no_toc\">DocumentReference</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n\n <p>Resource Specific Documentation:</p>\n <blockquote><div><p>Required resource type to support the <code>$submit-attachment</code> operation</p>\n</div></blockquote>\n\n \n\n <p>Supported Profiles:</p>\n <ul>\n \n <li><strong>SHALL</strong> support \n <a href=\"http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-documentreference.html\">US Core DocumentReference Profileversion: {0}3.1.1)</a>\n </li>\n \n <li><strong>SHALL</strong> support \n <a href=\"http://hl7.org/fhir/us/core/STU6.1/StructureDefinition-us-core-documentreference.html\">US Core DocumentReference Profileversion: {0}6.1.0)</a>\n </li>\n \n <li><strong>SHALL</strong> support \n <a href=\"http://hl7.org/fhir/us/core/STU7/StructureDefinition-us-core-documentreference.html\">US Core DocumentReference Profileversion: {0}7.0.0)</a>\n </li>\n \n </ul>\n \n \n\n\n <p>\n \n\n \n\n \n\n \n </p>\n\n\n\n\n\n\n <!-- Resource Interactions -->\n \n\n <!-- Resource Operations -->\n \n\n\n\n <!-- TODO Nexted ul items do not appear with a subbullet style -->\n \n <br/>\n <p>Modify Criteria:</p> \n <ul>\n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>create</code> interaction posting a DocumentReference resource using:\n <code class=\"highlighter-rouge\">POST [base]/DocumentReference/[id]{?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A Client <strong>SHOULD</strong> be capable of putting a existing DocumentReference resource using:\n <code class=\"highlighter-rouge\">PUT [base]/DocumentReference/[id]{?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n <li>\n A Client <strong>MAY</strong> be capable of patching an existing DocumentReference resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/DocumentReference/[id]{?_format=[mime-type]}</code>\n </li>\n \n\n \n \n\n \n\n \n <li>\n A Client <strong>MAY</strong> be capable of deleting a DocumentReference resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n </ul>\n \n\n\n \n <br/>\n <p>Fetch and Search Criteria:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>search-type</code> interaction fetching DocumentReference resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/DocumentReference/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>read</code> interaction fetching a DocumentReference resource using:\n <code class=\"highlighter-rouge\">GET [base]/DocumentReference/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a DocumentReference resource using:\n <code class=\"highlighter-rouge\">GET [base]/DocumentReference/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-instance</code> interaction fetching a history of a DocumentReference using:\n <code class=\"highlighter-rouge\">GET [base]/DocumentReference/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of DocumentReference resources using:\n <code class=\"highlighter-rouge\">GET [base]/DocumentReference/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n\n </ul>\n \n\n \n\n <!-- Search Combination -->\n \n \n \n\n \n <h4 id=\"Client_Parameters\" class=\"no_toc\">Parameters</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n\n <p>Resource Specific Documentation:</p>\n <blockquote><div><p>Required resource type to support the <code>$submit-attachment</code> operation</p>\n</div></blockquote>\n\n \n\n \n \n\n\n <p>\n \n\n \n\n \n\n \n </p>\n\n\n\n\n\n\n <!-- Resource Interactions -->\n \n\n <!-- Resource Operations -->\n \n\n\n\n <!-- TODO Nexted ul items do not appear with a subbullet style -->\n \n <br/>\n <p>Modify Criteria:</p> \n <ul>\n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>create</code> interaction posting a Parameters resource using:\n <code class=\"highlighter-rouge\">POST [base]/Parameters/[id]{?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A Client <strong>SHOULD</strong> be capable of putting a existing Parameters resource using:\n <code class=\"highlighter-rouge\">PUT [base]/Parameters/[id]{?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n <li>\n A Client <strong>MAY</strong> be capable of patching an existing Parameters resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/Parameters/[id]{?_format=[mime-type]}</code>\n </li>\n \n\n \n \n\n \n\n \n <li>\n A Client <strong>MAY</strong> be capable of deleting a Parameters resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n </ul>\n \n\n\n \n <br/>\n <p>Fetch and Search Criteria:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>search-type</code> interaction fetching Parameters resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/Parameters/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>read</code> interaction fetching a Parameters resource using:\n <code class=\"highlighter-rouge\">GET [base]/Parameters/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a Parameters resource using:\n <code class=\"highlighter-rouge\">GET [base]/Parameters/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-instance</code> interaction fetching a history of a Parameters using:\n <code class=\"highlighter-rouge\">GET [base]/Parameters/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of Parameters resources using:\n <code class=\"highlighter-rouge\">GET [base]/Parameters/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n\n </ul>\n \n\n \n\n <!-- Search Combination -->\n \n \n \n\n \n <h4 id=\"Client_QuestionnaireResponse\" class=\"no_toc\">QuestionnaireResponse</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n\n <p>Resource Specific Documentation:</p>\n <blockquote><div><p>Required resource type to support the <code>$submit-attachment</code> operation for Requesting Attachments Using Questionnaires. <em>SHALL</em>* support CDex SDC QuestionnaireResponse Profile for signed QuestionnaireResponse.</p>\n</div></blockquote>\n\n \n\n <p>Supported Profiles:</p>\n <ul>\n \n <li><strong>SHOULD</strong> support \n <a href=\"StructureDefinition-cdex-sdc-questionnaireresponse.html\">CDex SDC QuestionnaireResponse Profileversion: {0}2.1.0-snapshot)</a>\n </li>\n \n </ul>\n \n \n\n\n <p>\n \n\n \n\n \n\n \n </p>\n\n\n\n\n\n\n <!-- Resource Interactions -->\n \n\n <!-- Resource Operations -->\n \n\n\n\n <!-- TODO Nexted ul items do not appear with a subbullet style -->\n \n <br/>\n <p>Modify Criteria:</p> \n <ul>\n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>create</code> interaction posting a QuestionnaireResponse resource using:\n <code class=\"highlighter-rouge\">POST [base]/QuestionnaireResponse/[id]{?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A Client <strong>SHOULD</strong> be capable of putting a existing QuestionnaireResponse resource using:\n <code class=\"highlighter-rouge\">PUT [base]/QuestionnaireResponse/[id]{?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n <li>\n A Client <strong>MAY</strong> be capable of patching an existing QuestionnaireResponse resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/QuestionnaireResponse/[id]{?_format=[mime-type]}</code>\n </li>\n \n\n \n \n\n \n\n \n <li>\n A Client <strong>MAY</strong> be capable of deleting a QuestionnaireResponse resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n </ul>\n \n\n\n \n <br/>\n <p>Fetch and Search Criteria:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>search-type</code> interaction fetching QuestionnaireResponse resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/QuestionnaireResponse/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>read</code> interaction fetching a QuestionnaireResponse resource using:\n <code class=\"highlighter-rouge\">GET [base]/QuestionnaireResponse/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a QuestionnaireResponse resource using:\n <code class=\"highlighter-rouge\">GET [base]/QuestionnaireResponse/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-instance</code> interaction fetching a history of a QuestionnaireResponse using:\n <code class=\"highlighter-rouge\">GET [base]/QuestionnaireResponse/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of QuestionnaireResponse resources using:\n <code class=\"highlighter-rouge\">GET [base]/QuestionnaireResponse/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n\n </ul>\n \n\n \n\n <!-- Search Combination -->\n \n \n \n\n \n <h4 id=\"Client_ServiceRequest\" class=\"no_toc\">ServiceRequest</h4>\n\n <p>Conformance Expectation:\t<strong>SHOULD</strong></p>\n\n <p>Resource Specific Documentation:</p>\n <blockquote><div><p>Required resource type to carry authorization information regarding for requesting Clinical information</p>\n</div></blockquote>\n\n \n\n \n \n\n\n <p>\n \n\n \n\n \n\n \n </p>\n\n\n\n\n\n\n <!-- Resource Interactions -->\n \n\n <!-- Resource Operations -->\n \n\n\n\n <!-- TODO Nexted ul items do not appear with a subbullet style -->\n \n <br/>\n <p>Modify Criteria:</p> \n <ul>\n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>create</code> interaction posting a ServiceRequest resource using:\n <code class=\"highlighter-rouge\">POST [base]/ServiceRequest/[id]{?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n <li>\n <!-- TODO change note if server allows putting of a new one (with a specified ID) -->\n A Client <strong>MAY</strong> be capable of putting a existing ServiceRequest resource using:\n <code class=\"highlighter-rouge\">PUT [base]/ServiceRequest/[id]{?_format=[mime-type]}</code>\n \n </li>\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n <li>\n A Client <strong>MAY</strong> be capable of patching an existing ServiceRequest resource using:\n <code class=\"highlighter-rouge\">PATCH [base]/ServiceRequest/[id]{?_format=[mime-type]}</code>\n </li>\n \n\n \n \n\n \n\n \n <li>\n A Client <strong>MAY</strong> be capable of deleting a ServiceRequest resource using:\n <code class=\"highlighter-rouge\">DELETE [base]//[id]</code>\n \n </li>\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n \n\n \n\n \n\n\n \n\n \n </ul>\n \n\n\n \n <br/>\n <p>Fetch and Search Criteria:</p>\n <ul>\n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>search-type</code> interaction fetching ServiceRequest resources matching a search query using:\n <code class=\"highlighter-rouge\">GET [base]/ServiceRequest/[id]{?[parameters]{&_format=[mime-type]}}</code>\n </li>\n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>read</code> interaction fetching a ServiceRequest resource using:\n <code class=\"highlighter-rouge\">GET [base]/ServiceRequest/[id]</code>\n \n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>SHOULD</strong> be capable of a <code>vread</code> interaction fetching a ServiceRequest resource using:\n <code class=\"highlighter-rouge\">GET [base]/ServiceRequest/[id]/_history/vid</code>\n </li>\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-instance</code> interaction fetching a history of a ServiceRequest using:\n <code class=\"highlighter-rouge\">GET [base]/ServiceRequest/[id]/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n \n \n \n \n \n \n <li>\n A Client <strong>MAY</strong> be capable of a <code>history-type</code> interaction fetching the history of ServiceRequest resources using:\n <code class=\"highlighter-rouge\">GET [base]/ServiceRequest/_history{?[parameters]&_format=[mime-type]}</code>\n </li>\n \n \n\n \n\n \n\n </ul>\n \n\n \n\n <!-- Search Combination -->\n \n \n \n\n \n \n\n\n\n \n\n\n\n\n\n\n\n\n\n <!-- Messaging Capabilities -->\n \n\n <!-- Document Capabilities -->\n \n\n</div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "claims"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 2,
"_valueInteger" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://hl7.org/fhir/us/davinci-cdex/ImplementationGuide/hl7.fhir.us.davinci-cdex"
}
]
}
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use",
"_valueCode" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://hl7.org/fhir/us/davinci-cdex/ImplementationGuide/hl7.fhir.us.davinci-cdex"
}
]
}
}
],
"url" : "http://hl7.org/fhir/us/davinci-cdex/CapabilityStatement/data-source-client",
"version" : "2.1.0-snapshot",
"name" : "DataSourceClientCapabilityStatement",
"title" : "Data Source Client CapabilityStatement",
"status" : "active",
"experimental" : false,
"date" : "2024-09-10T14:37:40.292045-08:00",
"publisher" : "HL7 International / Payer/Provider Information Exchange Work Group",
"contact" : [
{
"name" : "HL7 International / Payer/Provider Information Exchange Work Group",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/claims"
},
{
"system" : "email",
"value" : "pie@lists.hl7.org"
}
]
}
],
"description" : "This CapabilityStatement describes the expected capabilities of a Da Vinci CDex Data Source in *Client* mode during clinical data exchange with a Data Consumer. The capabilities include one or more of the following interactions:\n1. Post the `$submit-attachment` operation to a Data Consumer endpoint.\n2. Launch Da Vinci DTR.\n3. Query for Authorization information represented by a CommunicationRequest or ServiceRequest.\n4. Post a subscription notification to a Data Consumer endpoint updating the status of a task.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "US"
}
]
}
],
"copyright" : "Used by permission of HL7 International all rights reserved Creative Commons License",
"kind" : "requirements",
"instantiates" : [
"http://hl7.org/fhir/us/core/CapabilityStatement/us-core-client|3.1.1",
"http://hl7.org/fhir/us/core/CapabilityStatement/us-core-client|6.1.0",
"http://hl7.org/fhir/us/core/CapabilityStatement/us-core-client|7.0.0"
],
"_instantiates" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"fhirVersion" : "4.0.1",
"format" : [
"json",
"xml"
],
"_format" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
]
}
],
"implementationGuide" : [
"http://hl7.org/fhir/us/davinci-dtr/ImplementationGuide/hl7.fhir.us.davinci-dtr|2.0.1"
],
"_implementationGuide" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"rest" : [
{
"mode" : "client",
"documentation" : "The Da Vinci CDex Data Source Client **SHALL**:\n\n1. Support at least one of the CDex approaches for exchanging clinical information\n 1. Task-Based Approach\n 1. Attachments\n1. Follow the guidelines for [Generating and Verifying Signed Resources](signatures.html) *if signatures are required*.\n1. Support JSON source formats for all Da Vinci CDex interactions.\n1. Declare a CapabilityStatement identifying transactions, and profiles supported.\n - Follow the guidelines for [Conforming to CDex Attachments](attachments-conformance.html) if supporting this exchange.\nThe Da Vinci CDex Data Source Client **MAY**:\n\n1. Support XML source formats for all Da Vinci CDex interactions.\n \n > Implementers that choose to support XML need to be aware that JSON Web Signatures can only be created and validated in the original native JSON. Transforms to and from XML will invalidate signatures.\n\n",
"security" : {
"description" : "1. For general security consideration refer to the FHIR [Security and Privacy Considerations](http://build.fhir.org/secpriv-module.html). \n1. For security considerations specific to this guide refer to the [Security and Privacy](security.html) section."
},
"resource" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "CommunicationRequest",
"documentation" : "Required resource type to carry authorization information regarding for requesting Clinical information",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read",
"documentation" : "Either a CommunicationRequest or ServiceRequest is required if an Authorization is required for a particular clinical data exchange scenario"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "DocumentReference",
"supportedProfile" : [
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference|3.1.1",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference|6.1.0",
"http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference|7.0.0"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"documentation" : "Required resource type to support the `$submit-attachment` operation",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Parameters",
"documentation" : "Required resource type to support the `$submit-attachment` operation",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "QuestionnaireResponse",
"supportedProfile" : [
"http://hl7.org/fhir/us/davinci-cdex/StructureDefinition/cdex-sdc-questionnaireresponse|2.1.0-preview"
],
"_supportedProfile" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
]
}
],
"documentation" : "Required resource type to support the `$submit-attachment` operation for Requesting Attachments Using Questionnaires. *SHALL** support CDex SDC QuestionnaireResponse Profile for signed QuestionnaireResponse.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "ServiceRequest",
"documentation" : "Required resource type to carry authorization information regarding for requesting Clinical information",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "create"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "search-type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "read",
"documentation" : "Either a CommunicationRequest or ServiceRequest is required if an Authorization is required for a particular clinical data exchange scenario"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "vread"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "patch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-instance"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-type"
}
]
}
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "transaction"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "batch"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "search-system"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-system"
}
],
"operation" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "submit-attachment",
"definition" : "http://hl7.org/fhir/us/davinci-cdex/OperationDefinition/submit-attachment",
"documentation" : "If [Attachments](attachments.html) is supported, the Data Source Client **SHALL** support the `$submit-attachment` operation."
}
]
}
]
}
XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.